home *** CD-ROM | disk | FTP | other *** search
/ The Atari Compendium / The Atari Compendium (Toad Computers) (1994).iso / files / umich / network / ka9q / nhclb120.zoo / readme.2 < prev    next >
Text File  |  1992-05-28  |  15KB  |  337 lines
  1. KA9Q TCP is an implementation of TCP/IP for the PC.  This is a Unix
  2. port based on a version from mid-1989.  Unfortunately the more recent
  3. versions of KA9Q are harder to port to Linux.
  4.  
  5. I don't have a manual for this exact version.  There's builtin help.
  6. The commands primarily set parameters (the ip and tcp commands), or
  7. start services.  In general the same command is used to set and
  8. examine parameters.  When you type the command with no value, it shows
  9. the current value. 
  10.  
  11. To use KA9Q, put startup.net and possibly domain.txt in your home
  12. directory, and run "net".  You will probably need to tailor
  13. startup.net for your configuration.  See the section at the end of
  14. this document on configuration.  Note that you can give an argument to
  15. the "net" command.  It will be used as the startup file in place of
  16. startup.net.  By default, startup.net and other files are in your home
  17. directory (the value of the environment variable HOME).  You can put
  18. them somewhere else by using the environment variable NETHOME.
  19.  
  20. If you are using SLIP, note that you must first dial the modem and
  21. establish a SLIP connection.  The exact details on doing this are
  22. different at each site.  Unfortunately you're probably going to need
  23. help from system or network support staff in order to use SLIP.
  24. Because SLIP effectively connects you to someone's local network,
  25. using it normally requires logging in with a password.  I recommend
  26. using kermit's script facility to dial and set up SLIP.  It did not
  27. seem work adding a similar facility to KA9Q.
  28.  
  29. If your site does not current support SLIP, they will probably have to
  30. do a bit of systems work.  For Unix systems, typically this will
  31. involve adding a SLIP device driver, and then enabling routing.  (An
  32. appropriate driver is available for the Sun, although I don't know
  33. where.  I believe it can be installed without Sun source.)  Many
  34. terminal servers will support SLIP directly, so enabling it will
  35. merely involve changing a configuration file.
  36.  
  37. Aside from configuration commands (which typically go into
  38. startup.net), the most common commands are probably telnet and ftp.
  39. Both take a host name.  Once you are connected, the "escape character"
  40. (initially ^]) lets you do some special things.  You type it followed
  41. by another character. Except for the escape character, the characters
  42. are folded, so that c, C, and ^C are equivalent.  Here's a list of the
  43. special characters:
  44.  
  45.   escape character (i.e. two in a row) - send a real escape character
  46.   x or ^x - return to command mode
  47.   b or ^b - send break
  48.   c or ^c - send interrupt process
  49.   o or ^c - abort output
  50.   t or ^t - are you there?
  51.   h or ^h - send telnet erase character
  52.   u or ^u - send telnet erase line
  53.   ?       - print this help message
  54.   
  55. Once you return to command mode, the "session" command can be used to
  56. switch between connections.  With no arguments, it shows the current
  57. sessions.  With a number, it will reconnect you to that session.
  58. There's a disconnect command to kill a session (also some stronger
  59. ways of doing it).
  60.  
  61. Telnet normally operates in full duplex, with the other system
  62. echoing.  However if that system refuses echoing, or if you use the
  63. command "echo refuse", KA9Q will echo locally.  In this case you have
  64. the normal line editing functions.  Several control characters have
  65. special functions.  Note that in local echo mode, you do not need to
  66. hit the escape character first.
  67.  
  68.   escape character - return to command mode
  69.   ^v - quote the next character
  70.   ^b - send break
  71.   ^c - send interrupt process
  72.   ^o - abort output
  73.   ^t - are you there?
  74.  
  75. Telnet will pass your TERM environment variable as the terminal type
  76. if the other end asks for it.  It will implement flow control locally
  77. if the other end understand the remote flow control option.  If the
  78. other end does a "telnet sync" correctly, it will suppress output when
  79. appropriate.  E.g. when talking to a Unix system, if you type ^C or ^O
  80. in the middle of a large output, output should stop immediately.
  81. However there may be a pause before getting the next prompt, as some
  82. previously buffered data is probably still going to be transmitted.
  83.  
  84. The "ip stat" and "tcp stat" commands are useful to get statistics.
  85. "Ip stat" shows both the IP and SLIP level.  If header compression is
  86. being used, it will show how many packets were compressed and how many
  87. were oot.
  88.  
  89. FTP is sort of odd.  It looks like you are in an interactive
  90. conversation with the FTP server at the other end, with no local
  91. command prompt.  Most commands are passed directly to the remote
  92. server, but in fact there is a local command parser, which will
  93. intervene for a few commands:
  94.  
  95.    cd, dir, list, get, ls, mkdir, nlst, rmdir, put, type
  96.  
  97. get and put should be used to transfer files.
  98.  
  99. It's possible to run a server which others can connect to, though I
  100. haven't tried it except for ftp.  The command is "start ftp", etc.
  101. For ftp, a login is required.  The file ftpusers, in your home
  102. directory, contains a list of users and passwords.
  103.  
  104. Here's a list of commands:
  105.  
  106.    ! - call a recursive shell
  107.    arp - set arp parameters
  108.    ax25 - configure ham interface
  109.    attach - define an interface - must be used for each interface
  110.    bootp - request our IP address from a server
  111.    connect - for AX25, define call sign for interface
  112.    cd
  113.    close
  114.    disconnect
  115.    dir - do a directory on the local system
  116.    domain - configure domain name system
  117.    eaglestat
  118.    echo - refuse or accept - request to disable telnet remote echo
  119.    eol - Unix or standard end of line options [standard is recommended,
  120.     even for use on Unix systems]
  121.    escape - change escape character
  122.    etherstat
  123.    exit
  124.    finger
  125.    forward - divert packets from one interface to another
  126.    ftp - open an ftp connection
  127.    hapnstat
  128.    help - print command list
  129.    hostname - set/examine host name
  130.    kick
  131.    log
  132.    ip - set/examine IP level parameters
  133.    memstat
  134.    mbox, mode - AX25 commands
  135.    mulport
  136.    netrom
  137.    nrstat
  138.    param - set/examine interafce parameters
  139.    ping - send ping to a host
  140.    pwd 
  141.    rdate [offset] [host] - set date/time from UDP time daemon.  see below
  142.    record
  143.    remote
  144.    reset - kill connection
  145.    route - set up routes
  146.    session - see above: move to a different session
  147.    shell - call a subshell
  148.    smtp - mail handling
  149.    start - start server
  150.    stop - stop server
  151.    tcp - set/examine tcp parameters
  152.    telnet - open telnet connection
  153.    trace - enable low-level debugging (no arguments - show current status)
  154.     trace to <file> - put trace output on file (use "con" for console)
  155.     trace <device> [<bits>] - trace packets on device
  156.         device is typically "sl0" or "loopback"
  157.         bits are in hex:
  158.             1 - output, 10 - input (else no tracing)
  159.             100 - dump data in ascii, 200 - hex (else headers only)
  160.     trace cmdmode|allmode - show trace just when at command level?
  161.     trace telnet [on | off] - show telnet options and urgent data
  162.    udp - set/examine udp parameters
  163.    upload
  164.    wait - control mail select
  165.  
  166. The rdate command uses the old-style time protocol (often known as
  167. "rdate"), on UDP port 37, to get the date and time, and then sets the
  168. system clock.  Note that the protocol always gives time in GMT.  If
  169. your system clock is running on GMT (which is the normal way Unix
  170. should run), this is fine.  Otherwise, you'll need to specify the
  171. offset in minutes.  For time zones west of GMT, this should be a
  172. negative number. For the Eastern U.S., when not in daylight time, the
  173. offset is -300, because EST is 5 hours (300 minutes) west of GMT.
  174. If no host is specified, a UDP broadcast is used.
  175.  
  176. This configuration of KA9Q has been tested only with SLIP.  Code is
  177. also included for the KISS device (for ham radio) and Linux generic
  178. Ethernet support using /dev/eth.  /dev/eth should either work or come
  179. close to working: it's based on diffs made from a recent version of
  180. KA9Q.  I don't know of anyone who has tested KISS.  Past experience
  181. suggests that users will prefer Kermit to SLIP unless you use SLIP
  182. with header compression.
  183.  
  184. Note that this program depends up non-blocking I/O and the select
  185. system call.  In Linux 0.12, these did not work.  There are patches,
  186. nonblock.tar.Z and select.patch, on the major distribution machines.
  187. Don't forget: after patching a